Update docs to detail resetModules: false behavior #6641
Conversation
The documentation at the moment describes the behavior of Jest when `resetModules` is set to `true`, but leaves the default/false case unclarified. I had a misconception that the module registry would not be reset at all in the false case, where it's still reset between different test files. This misconception was clarified by SimienB in issue jestjs#6007. The reporter of issue jestjs#4413 also had this question. This commit updates the documentation of `resetModules` to explain the default case more explicitly.
Codecov Report
@@ Coverage Diff @@
## master #6641 +/- ##
=======================================
Coverage 63.73% 63.73%
=======================================
Files 235 235
Lines 8935 8935
Branches 3 4 +1
=======================================
Hits 5695 5695
Misses 3239 3239
Partials 1 1Continue to review full report at Codecov.
|
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed. If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
|
Thanks @gluxon! |
This Pull Request renovates the package group "jest monorepo". - [jest-environment-node](https://github.com/facebook/jest) (`devDependencies`): from `23.2.0` to `23.3.0` - [jest](https://github.com/facebook/jest) (`devDependencies`): from `23.2.0` to `23.3.0` # Release Notes <details> <summary>facebook/jest</summary> ### [`v23.3.0`](https://github.com/facebook/jest/blob/master/CHANGELOG.md#​2330) [Compare Source](jestjs/jest@v23.2.0...v23.3.0) ##### Features - `[jest-cli]` Allow watch plugin to be configured ([#​6603](`https://github.com/facebook/jest/pull/6603`)) - `[jest-snapshot]` Introduce `toMatchInlineSnapshot` and `toThrowErrorMatchingInlineSnapshot` matchers ([#​6380](`https://github.com/facebook/jest/pull/6380`)) ##### Fixes - `[jest-regex-util]` Improve handling already escaped path separators on Windows ([#​6523](`https://github.com/facebook/jest/pull/6523`)) - `[jest-cli]` Fix `testNamePattern` value with interactive snapshots ([#​6579](`https://github.com/facebook/jest/pull/6579`)) - `[jest-cli]` Fix enter to interrupt watch mode ([#​6601](`https://github.com/facebook/jest/pull/6601`)) ##### Chore & Maintenance - `[website]` Switch domain to https://jestjs.io ([#​6549](`https://github.com/facebook/jest/pull/6549`)) - `[tests]` Improve stability of `yarn test` on Windows ([#​6534](`https://github.com/facebook/jest/pull/6534`)) - `[*]` Transpile object shorthand into Node 4 compatible syntax ([#​6582](`https://github.com/facebook/jest/pull/6582`)) - `[*]` Update all legacy links to jestjs.io ([#​6622](`https://github.com/facebook/jest/pull/6622`)) - `[docs]` Add docs for 23.1, 23.2, and 23.3 ([#​6623](`https://github.com/facebook/jest/pull/6623`)) - `[website]` Only test/deploy website if relevant files are changed ([#​6626](`https://github.com/facebook/jest/pull/6626`)) - `[docs]` Describe behavior of `resetModules` option when set to `false` ([#​6641](`https://github.com/facebook/jest/pull/6641`)) --- </details> --- This PR has been generated by [Renovate Bot](https://renovatebot.com).
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Summary
The documentation at the moment describes the behavior of Jest when
resetModulesis set totrue, but leaves the default/false case unclarified. I had a misconception that the module registry would not be reset at all in the false case, where it's still reset between different test files. This misconception was clarified by SimienB in issue #6007.The reporter of issue #4413 also had this question.
This commit updates the documentation of
resetModulesto explain the default case more explicitly.